home *** CD-ROM | disk | FTP | other *** search
/ Freelog Special Edition 10 / FreelogHS10.iso / Buzz / Buzz_Advanced_Pack.exe / {app} / Dev / Overloader - SDK / oeb 150 base api.txt next >
Text File  |  2001-11-06  |  3KB  |  132 lines
  1. Title:  OEB API Extensions
  2. Author: CyanPhase
  3. Date:   November 6, 2001
  4.  
  5.  
  6. Here's a brief overview of some of the Base functions that can be
  7. used from the OEB (Overloader Extended Buzz) dll. don't forget
  8. to have this at the beginning of your buzz machine's cpp file:
  9.  
  10. #include "../oeb150base.h"
  11.  
  12. assuming that oeb150base.h is in the same location as your machineinterface.h
  13.  
  14.  
  15. _______________________________________________________
  16.  
  17. void LoadGeneralOEB(int machine_type, HINSTANCE dllInst)
  18. _______________________________________________________
  19.  
  20. This function has to be called before any of the other
  21. functions are called. Its normally called during DllMain
  22. of a Buzz Machine, like this:
  23.  
  24.  
  25. BOOL WINAPI DllMain ( HANDLE hModule, DWORD fwdreason, LPVOID lpReserved ) {
  26.     switch (fwdreason) {
  27.     case DLL_PROCESS_ATTACH: {
  28.         dllInstance = (HINSTANCE) hModule;
  29.         LoadGeneralOEB(OEB_ISGENERATOR, dllInstance);
  30.         break;
  31.     }
  32.     case DLL_THREAD_ATTACH: break;
  33.     case DLL_THREAD_DETACH: break;
  34.     case DLL_PROCESS_DETACH: break;
  35.     }
  36.     return TRUE;
  37. }
  38.  
  39. If your buzz machine is a effect and not a generator,
  40. then use the OEB_ISEFFECT constant instead. If you
  41. don't specify the correct type of machine the OEB library
  42. might not get loaded for your machine. Valid constants
  43. include:
  44.  
  45. OEB_ISGENERATOR
  46. This means your machine is in Gear\Generator 
  47.  
  48. OEB_ISEFFECT
  49. This means your machine is in Gear\Effect 
  50.  
  51. OEB_ISGEAR
  52. This means your machine is in the root Gear directory
  53.  
  54. OEB_ISRECORDER
  55. This means your machine is in Gear\Recorders 
  56.  
  57. OEB_ISWAVEOUT
  58. This means your waveout driver is in WaveOutput
  59.  
  60. OEB_ISMAINBUZZ
  61. This means your dll is in the main buzz dir 
  62.  
  63.  
  64.  
  65.  
  66. _______________________________________________________
  67.  
  68. char * OEB_GetVersion()
  69. _______________________________________________________
  70.  
  71. Gets a string that tells the version of overloader and
  72. OEB that's loaded.
  73.  
  74.  
  75. _______________________________________________________
  76.  
  77. HWND OEB_GetBuzzWindow()
  78. _______________________________________________________
  79.  
  80. Gets a HWND of the main buzz window
  81.  
  82.  
  83.  
  84. _______________________________________________________
  85.  
  86. int OEB_GetTuning()
  87. _______________________________________________________
  88.  
  89. Gets the tuning type that is specified in the 
  90. Extended Options dialog box.
  91.  
  92.  
  93. _______________________________________________________
  94.  
  95. float OEB_GetManualTuning()
  96. _______________________________________________________
  97.  
  98. Gets the manual tuning that is specified in the 
  99. Extended Options dialog box.
  100.  
  101.  
  102. _______________________________________________________
  103.  
  104. int OEB_GetQuality()
  105. _______________________________________________________
  106.  
  107. Gets the quality setting that is specified in the 
  108. Extended Options dialog box.
  109.  
  110.  
  111. _______________________________________________________
  112.  
  113. int OEB_GetComponentLoaded(int component_id)
  114. _______________________________________________________
  115.  
  116. Tells what components are loaded.
  117.  
  118. component_id:
  119.  
  120. 0    Overloader
  121. 10   OOE (Overloader Output Extender)
  122. 22   A SongInfo machine
  123.  
  124. a return value of 0 means false, otherwise its true
  125.  
  126.  
  127.  
  128.  
  129.  
  130.  
  131.  
  132.